Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat: added agencyTimezone to JSON report summary #1946

Merged
merged 7 commits into from
Jan 28, 2025
Merged

feat: added agencyTimezone to JSON report summary #1946

merged 7 commits into from
Jan 28, 2025

Conversation

cka-y
Copy link
Contributor

@cka-y cka-y commented Jan 23, 2025 •
edited
Loading

Summary:

Closes #1943

Expected behavior:

Example JSON report using this feed.

Please make sure these boxes are checked before submitting your pull request - thanks!

  • Run the unit tests with gradle test to make sure you didn't break anything
  • Add or update any needed documentation to the repo
  • Format the title like "feat: [new feature short description]". Title must follow the Conventional Commit Specification(https://www.conventionalcommits.org/en/v1.0.0/).
  • Linked all relevant issues
  • Include screenshot(s) showing how this pull request works and fixes the issue(s)

@github-actions GitHub Actions
Copy link
Contributor

📝 Acceptance Test Report

📋 Summary

✅ The rule acceptance has passed for commit 7a41769
Download the full acceptance test report here (report will disappear after 90 days).

📊 Notices Comparison

New Errors (0 out of 1792 datasets, ~0%) ✅

No changes were detected due to the code change.

Dropped Errors (0 out of 1792 datasets, ~0%) ✅

No changes were detected due to the code change.

New Warnings (0 out of 1792 datasets, ~0%) ✅

No changes were detected due to the code change.

Dropped Warnings (0 out of 1792 datasets, ~0%) ✅

No changes were detected due to the code change.

🛡️ Corruption Check

0 out of 1792 sources (~0 %) are corrupted.

⏱️ Performance Assessment

📈 Validation Time

Assess the performance in terms of seconds taken for the validation process.

Time Metric Dataset ID Reference (s) Latest (s) Difference (s)
Average -- 3.67 3.77 ⬆️+0.10
Median -- 1.34 1.37 ⬆️+0.03
Standard Deviation -- 10.67 10.65 ⬇️-0.02
Minimum in References Reports us-california-city-of-wasco-gtfs-1788 0.48 0.55 ⬆️+0.07
Maximum in Reference Reports gb-unknown-uk-aggregate-feed-gtfs-2014 287.72 285.47 ⬇️-2.25
Minimum in Latest Reports us-oregon-high-desert-point-gtfs-636 0.52 0.52 ⬇️-0.01
Maximum in Latest Reports gb-unknown-uk-aggregate-feed-gtfs-2014 287.72 285.47 ⬇️-2.25
📜 Memory Consumption
Metric Dataset ID Reference (s) Latest (s) Difference (s)
Average -- 460.50 MiB 461.36 MiB ⬆️+886.29 KiB
Median -- 333.92 MiB 331.92 MiB ⬇️-2.00 MiB
Standard Deviation -- 740.46 MiB 727.70 MiB ⬇️-12.76 MiB
Minimum in References Reports us-connecticut-middletown-area-transit-gtfs-576 39.66 MiB 415.92 MiB ⬆️+376.26 MiB
Maximum in Reference Reports gb-unknown-uk-aggregate-feed-gtfs-2014 10.73 GiB 10.98 GiB ⬆️+264.30 MiB
Minimum in Latest Reports ro-vrancea-consiliul-judetean-vrancea-gtfs-1984 68.86 MiB 38.19 MiB ⬇️-30.66 MiB
Maximum in Latest Reports gb-unknown-uk-aggregate-feed-gtfs-2014 10.73 GiB 10.98 GiB ⬆️+264.30 MiB

@cka-y cka-y requested a review from davidgamez January 28, 2025 16:23
@davidgamez
Copy link
Member

Even considering that the spec specifies that all agencies must have the same timezone, I would prefer to add a timezone field to each agency to be more reflective of the dataset than add a single field to the metadata. Any thoughts? cc: @emmambd

@cka-y
Copy link
Contributor Author

cka-y commented Jan 28, 2025

I'm not sure i understand. Could you provide an example report of what you're expecting?

@davidgamez
Copy link
Member

I'm not sure i understand. Could you provide an example report of what you're expecting?

  "summary": {
    "validatorVersion": "6.0.1-SNAPSHOT",
    "validatedAt": "2025-01-28T11:35:43-05:00",
    "gtfsInput": "file:///Users/david/code/data/flex/garfieldcounty-wa-us--flex-v2/",
    "threads": 3,
    "outputDirectory": "/tmp/gtfs",
    "systemErrorsReportName": "system_errors.json",
    "validationReportName": "report.json",
    "htmlReportName": "report.html",
    "countryCode": "CA",
    "dateForValidation": "2025-01-28",
    "feedInfo": {
      "publisherName": "Trillium Solutions, Inc.",
      "publisherUrl": "http://www.trilliumtransit.com",
      "feedLanguage": "English",
      "feedStartDate": "2024-06-12",
      "feedEndDate": "2025-07-01",
      "feedEmail": "[email protected]",
      "feedServiceWindowStart": "2023-08-01",
      "feedServiceWindowEnd": "2025-07-01"
    },
    "agencies": [
      {
        "name": "Garfield County Transportation Authority",
        "url": "https://garfieldcta.com/",
        "phone": "(509) 843-0200",
        "email": "N/A",
        "timezone": "America/Los_Angeles" // ADD TIMEZONE PER AGENCY
      }
    ],
"agencyTimezone": "America/Los_Angeles", /// REMOVE THIS "GLOBAL" TIMEZONE

@github-actions GitHub Actions
Copy link
Contributor

📝 Acceptance Test Report

📋 Summary

✅ The rule acceptance has passed for commit 44339e1
Download the full acceptance test report here (report will disappear after 90 days).

📊 Notices Comparison

New Errors (0 out of 1801 datasets, ~0%) ✅

No changes were detected due to the code change.

Dropped Errors (0 out of 1801 datasets, ~0%) ✅

No changes were detected due to the code change.

New Warnings (0 out of 1801 datasets, ~0%) ✅

No changes were detected due to the code change.

Dropped Warnings (0 out of 1801 datasets, ~0%) ✅

No changes were detected due to the code change.

🛡️ Corruption Check

0 out of 1801 sources (~0 %) are corrupted.

⏱️ Performance Assessment

📈 Validation Time

Assess the performance in terms of seconds taken for the validation process.

Time Metric Dataset ID Reference (s) Latest (s) Difference (s)
Average -- 3.59 3.63 ⬆️+0.04
Median -- 1.30 1.35 ⬆️+0.05
Standard Deviation -- 10.34 10.45 ⬆️+0.10
Minimum in References Reports us-massachusetts-massachusetts-area-express-max-gtfs-431 0.48 0.51 ⬆️+0.03
Maximum in Reference Reports gb-unknown-uk-aggregate-feed-gtfs-2014 275.20 284.50 ⬆️+9.29
Minimum in Latest Reports us-california-west-berkeley-shuttle-gtfs-2238 0.48 0.47 ⬇️-0.01
Maximum in Latest Reports gb-unknown-uk-aggregate-feed-gtfs-2014 275.20 284.50 ⬆️+9.29
📜 Memory Consumption
Metric Dataset ID Reference (s) Latest (s) Difference (s)
Average -- 469.66 MiB 466.34 MiB ⬇️-3.32 MiB
Median -- 331.92 MiB 331.92 MiB ⬇️-32 bytes
Standard Deviation -- 773.51 MiB 758.28 MiB ⬇️-15.23 MiB
Minimum in References Reports us-virginia-star-transit-gtfs-819 39.95 MiB 39.92 MiB ⬇️-32.44 KiB
Maximum in Reference Reports gb-unknown-uk-aggregate-feed-gtfs-2014 10.51 GiB 10.73 GiB ⬆️+234.43 MiB
Minimum in Latest Reports us-washington-people-for-people-community-connector-gtfs-271 395.92 MiB 39.08 MiB ⬇️-356.85 MiB
Maximum in Latest Reports gb-unknown-uk-aggregate-feed-gtfs-2014 10.51 GiB 10.73 GiB ⬆️+234.43 MiB

davidgamez
davidgamez approved these changes Jan 28, 2025
View reviewed changes
Copy link
Member

@davidgamez davidgamez left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@cka-y cka-y merged commit 88cee5b into master Jan 28, 2025
140 checks passed
@cka-y cka-y deleted the feat/1943 branch January 28, 2025 18:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@davidgamez davidgamez davidgamez approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Include agency timezone in JSON summary report
2 participants
@cka-y @davidgamez